{-
	Copyright (c) 2009 Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	All rights reserved
	Licensed under GNU LGPL v2.1

	$Id: ItalianClassicDeck.hs 15 2009-09-28 21:16:23Z aitorlf $

	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU Lesser General Public
	License version 2.1 (and just under that one) as published by
	the Free Software Foundation.

	This program is distributed in the hope that it will be useful,
	but without any warranty; without even the implied warranty of
	merchantability or fitness for a particular purpose. See the GNU
	Lesser General Public License for more details.

	You should have received a copy of the GNU Lesser General Public
	License along with this program; if not, write to the Free
	Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
	MA 02111-1307, USA.
-}

{-|
	Module		: Games.Cards.Deck.ItalianClassicDeck
	Copyright	: (c) Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	License		: GNU LGPL v2.1 <http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html>

	Maintainer	: Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	Stability	: provisional
	Portability	: portable

	Definition of the Italian classic (40 cards) deck according to Games.Cards.Deck.

	This module defines the basic Italian 40 cards classic deck.
-}
module Games.Cards.Deck.ItalianClassicDeck(
		-- * Italian 40 cards classic deck
		-- ** Types defining cards and decks for the Italian classic deck
		ItalianClassicRank(..),
		ItalianRank,
		LatinSuit(..),
		ItalianClassicCard,
		ItalianCard,
		ItalianClassicDeck,
		ItalianDeck,
		-- ** Instance of Italian classic deck
		italianClassicDeck,
		italianDeck,
	)where

import Games.Cards.Deck


-- | Well-known ranks for the classic Italian deck.
data ItalianClassicRank =
		-- | 'Two'
		Two
		-- | 'Three'
		| Three
		-- | 'Four'
		| Four
		-- | 'Five'
		| Five
		-- | 'Six'
		| Six
		-- | 'Seven'
		| Seven
		-- | 'Knave'
		| Knave
		-- | 'Knight'
		| Knight
		-- | 'King'
		| King
		-- | 'Ace'
		| Ace
	deriving (Eq, Ord, Enum, Bounded, Show, Read)
instance CardRank ItalianClassicRank
-- | Alias @'ItalianClassicRank'@ as @'ItalianRank'@.
type ItalianRank = ItalianClassicRank


-- | Well-known suits for the Italian deck.
data LatinSuit =
		-- | 'Coins'
		Coins
		-- | 'Cups'
		| Cups
		-- | 'Swords'
		| Swords
		-- | 'Batons'
		| Batons
	deriving (Eq, Enum, Bounded, Show, Read)
instance CardSuit LatinSuit


-- | Definition of the 40 cards classic Italian @'Card'@s and @'Deck'@s.

-- | Italian classic card type.
type ItalianClassicCard = Card ItalianClassicRank LatinSuit WildCardNone
-- | Alias @'ItalianClassicCard'@ as @'ItalianCard'@.
type ItalianCard = ItalianClassicCard

-- | Italian classic deck type.
type ItalianClassicDeck = Deck ItalianClassicRank LatinSuit WildCardNone
-- | Alias @'ItalianClassicDeck'@ as @'ItalianDeck'@.
type ItalianDeck = ItalianClassicDeck

-- | Italian classic deck instance.
italianClassicDeck :: ItalianClassicDeck
italianClassicDeck = deck

-- | Italian deck instance.
italianDeck :: ItalianClassicDeck
italianDeck = italianClassicDeck
